home *** CD-ROM | disk | FTP | other *** search
/ Aminet 31 / Aminet 31 (1999)(Schatztruhe)[!][Jun 1999].iso / Aminet / comm / news / slrn-bin.lha / slrn / doc / tm / slrnfuns / article.tm next >
Text File  |  1999-04-27  |  3KB  |  106 lines
  1. \function{article_as_string}
  2. \synopsis{-}
  3. \usage{String article_as_string ()}
  4. \description
  5.    This function will return the entire contents of the current
  6.    article as a string.
  7. \seealso{}
  8. \done
  9.  
  10. \function{get_next_art_pgdn_action}
  11. \synopsis{-}
  12. \usage{Integer get_next_art_pgdn_action ()}
  13. \description
  14.    This function may be used to get information about what action slrn
  15.    will take when an attempt is made to go to the next page of the
  16.    current article, e.g., by pressing the space key.  It returns one
  17.    of the following integers:
  18. #v+
  19.        -1  Not in article mode
  20.         0  Next page of the article will be displayed
  21.         1  The next unread article will be displayed
  22.         2  The newsreader will go to the next newsgroup
  23. #v-
  24. \done
  25.  
  26. \function{is_article_visible}
  27. \synopsis{-}
  28. \usage{Integer is_article_visible ()}
  29. \description
  30.    This function returns information about whether or not the article
  31.    associated with the current header is visible in a window.
  32.    Specifically, it returns:
  33. #v+
  34.       0  : if the article window is hidden
  35.       1  : if the article window is showing but the current header
  36.              does not refer to the article
  37.       3  : if the article window contains the current header article
  38. #v-
  39. \seealso{is_article_window_zoomed, call}
  40. \done
  41.  
  42. \function{is_article_window_zoomed}
  43. \synopsis{-}
  44. \usage{Integer is_article_window_zoomed ()}
  45. \description
  46.    This function returns 1 if the article window is zoomed, or 0
  47.    otherwise.
  48. \seealso{is_article_visible, call}
  49. \done
  50.  
  51. \function{pipe_article}
  52. \synopsis{-}
  53. \usage{Void pipe_article (String cmd)}
  54. \description
  55.    This function may be used to pipe the current article to the command
  56.    given by the \var{cmd} argument.
  57. \seealso{read_mini}
  58. \done
  59.  
  60. \function{re_search_article}
  61. \synopsis{-}
  62. \usage{Integer re_search_article (String pat)}
  63. \description
  64.    This function searches forward in the article associated with the
  65.    currently selected header for a string matching the regular
  66.    expression given by the parameter \var{pat}.  It returns 0 if no
  67.    matching line is found.   Otherwise, it returns 1 and the matching
  68.    line will be left on the stack as a string.
  69. \seealso{search_article}
  70. \done
  71.  
  72. \function{save_current_article}
  73. \synopsis{-}
  74. \usage{Integer save_current_article (String filename)}
  75. \description
  76.    This function saves the currently selected article to a file
  77.    specified by \var{filename}.  It returns 0 upon success or -1 upon
  78.    failure.
  79. \notes
  80.    This function always creates a new file.
  81. \seealso{}
  82. \done
  83.  
  84. \function{search_article}
  85. \synopsis{-}
  86. \usage{Integre search_article (String str)}
  87. \description
  88.    This function searches forward in the article associated with the
  89.    currently selected header for the string given by the parameter
  90.    \var{str}.  It returns 0 if no matching line is found.  Otherwise, it
  91.    returns 1 and the matching line will be left on the stack as a
  92.    string.
  93. \seealso{re_search_article}
  94. \done
  95.  
  96. \function{set_article_window_size}
  97. \synopsis{-}
  98. \usage{Void set_article_window_size (Integer nrows)}
  99. \description
  100.    The \var{set_article_window_size} may be used to set the height of the
  101.    article window.  The variable \var{SCREEN_HEIGHT} may be used to
  102.    facilitate this.
  103. \seealso{}
  104. \done
  105.  
  106.